package org.sundatagroup.aurora.core.controller;

import com.google.gson.JsonObject;

/**
 * <p>统一的 Json 类型文本返回数据格式的接口
 * <p>统一返回给前端的 Json 数据格式是这样的:
 * <blockquote><pre>
 * {
 *     "result" : &lt;boolean&gt;,
 *     // 其它数据
 * }
 * </pre></blockquote>
 * <p>这个格式中 result 用于表示返回是否操作成功, 或者查询成功.
 * </p>
 * 
 * @author Zdream
 * @date 2018-04-18
 * @since 0.1.1
 */
public interface IJsonResultController {
    
    default JsonObject rawResultJsonObject() {
    	return rawResultJsonObject(true);
    }
    
    default JsonObject rawResultJsonObject(boolean result) {
    	JsonObject ret = new JsonObject();
    	ret.addProperty("result", result);
    	return ret;
    }

}
